<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xxvethernet: xxxvethernet_example.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xxvethernet
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xxxvethernet__example_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">xxxvethernet_example.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>Defines common data types, prototypes, and includes the proper headers for use with the Xxv Ethernet and USXGMII example code residing in this directory. </p>
<p>This file along with <a class="el" href="xxxvethernet__example__util_8c.html" title="This file implements the utility functions for the Xxv Ethernet and USXGMII example code...">xxxvethernet_example_util.c</a> are utilized with the specific example code in the other source code files provided.</p>
<p>These examples are designed to be compiled and utilized within the EDK standalone BSP development environment. The readme file contains more information on build requirements needed by these examples.</p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date     Changes
</p>
<hr/>
<p>
1.0   hk   06/16/17 First release
      hk   02/15/18 Add support for USXGMII</pre><pre></pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a445292fcf7f28cbf3a9c379eb311b371"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xxxvethernet__example_8h.html#a445292fcf7f28cbf3a9c379eb311b371">XxvEthernetUtilFrameHdrFormatMAC</a> (EthernetFrame *FramePtr, char *DestAddr, char *SrcAddr)</td></tr>
<tr class="memdesc:a445292fcf7f28cbf3a9c379eb311b371"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the MAC addresses in the frame.  <a href="#a445292fcf7f28cbf3a9c379eb311b371">More...</a><br/></td></tr>
<tr class="separator:a445292fcf7f28cbf3a9c379eb311b371"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10525c2457e7790f874b9bef3635b322"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xxxvethernet__example_8h.html#a10525c2457e7790f874b9bef3635b322">XxvEthernetUtilFrameHdrFormatType</a> (EthernetFrame *FramePtr, u16 FrameType)</td></tr>
<tr class="memdesc:a10525c2457e7790f874b9bef3635b322"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the frame type for the specified frame.  <a href="#a10525c2457e7790f874b9bef3635b322">More...</a><br/></td></tr>
<tr class="separator:a10525c2457e7790f874b9bef3635b322"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3435bac2a9a1be6bd28fda22f93c5f7c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xxxvethernet__example_8h.html#a3435bac2a9a1be6bd28fda22f93c5f7c">XxvEthernetUtilFrameSetPayloadData</a> (EthernetFrame *FramePtr, int PayloadSize)</td></tr>
<tr class="memdesc:a3435bac2a9a1be6bd28fda22f93c5f7c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function places a pattern in the payload section of a frame.  <a href="#a3435bac2a9a1be6bd28fda22f93c5f7c">More...</a><br/></td></tr>
<tr class="separator:a3435bac2a9a1be6bd28fda22f93c5f7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9442be912857bc50928bb7a53d5b6685"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xxxvethernet__example_8h.html#a9442be912857bc50928bb7a53d5b6685">XxvEthernetUtilFrameVerify</a> (EthernetFrame *CheckFrame, EthernetFrame *ActualFrame)</td></tr>
<tr class="memdesc:a9442be912857bc50928bb7a53d5b6685"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function verifies the frame data against a CheckFrame.  <a href="#a9442be912857bc50928bb7a53d5b6685">More...</a><br/></td></tr>
<tr class="separator:a9442be912857bc50928bb7a53d5b6685"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad9494c30f93da4a8476ec61c8b1605b5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xxxvethernet__example_8h.html#ad9494c30f93da4a8476ec61c8b1605b5">XxvEthernetUtilFrameMemClear</a> (EthernetFrame *FramePtr)</td></tr>
<tr class="memdesc:ad9494c30f93da4a8476ec61c8b1605b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets all bytes of a frame to 0.  <a href="#ad9494c30f93da4a8476ec61c8b1605b5">More...</a><br/></td></tr>
<tr class="separator:ad9494c30f93da4a8476ec61c8b1605b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb5bc0fd706a832742ca65487e6687af"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xxxvethernet__example_8h.html#abb5bc0fd706a832742ca65487e6687af">XxvEthernetUtilEnterLocalLoopback</a> (<a class="el" href="struct_x_xxv_ethernet.html">XXxvEthernet</a> *XxvEthernetInstancePtr)</td></tr>
<tr class="memdesc:abb5bc0fd706a832742ca65487e6687af"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets 10G ethernet in local loopback.  <a href="#abb5bc0fd706a832742ca65487e6687af">More...</a><br/></td></tr>
<tr class="separator:abb5bc0fd706a832742ca65487e6687af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5577a2e1499d8be6c88fcac63e8d553"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xxxvethernet__example_8h.html#ae5577a2e1499d8be6c88fcac63e8d553">XxvEthernetUtilErrorTrap</a> (const char *Message)</td></tr>
<tr class="memdesc:ae5577a2e1499d8be6c88fcac63e8d553"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function is called by example code when an error is detected.  <a href="#ae5577a2e1499d8be6c88fcac63e8d553">More...</a><br/></td></tr>
<tr class="separator:ae5577a2e1499d8be6c88fcac63e8d553"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad48448f068a15369349deec579b8fc38"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xxxvethernet__example_8h.html#ad48448f068a15369349deec579b8fc38">XxvEthernetUtilUsxgmiiSetup</a> (<a class="el" href="struct_x_xxv_ethernet.html">XXxvEthernet</a> *XxvEthernetInstancePtr, u32 Rate, u32 Duplex)</td></tr>
<tr class="memdesc:ad48448f068a15369349deec579b8fc38"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets up USXGMII at specified speed.  <a href="#ad48448f068a15369349deec579b8fc38">More...</a><br/></td></tr>
<tr class="separator:ad48448f068a15369349deec579b8fc38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80999962d45ad1ec4e8dcb68df838cdf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xxxvethernet__example_8h.html#a80999962d45ad1ec4e8dcb68df838cdf">XxvEthernetUtilUsxgmiiSetupBypassAN</a> (<a class="el" href="struct_x_xxv_ethernet.html">XXxvEthernet</a> *XxvEthernetInstancePtr, u32 Rate, u32 Duplex)</td></tr>
<tr class="memdesc:a80999962d45ad1ec4e8dcb68df838cdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets up USXGMII at specified speed.  <a href="#a80999962d45ad1ec4e8dcb68df838cdf">More...</a><br/></td></tr>
<tr class="separator:a80999962d45ad1ec4e8dcb68df838cdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="abb5bc0fd706a832742ca65487e6687af"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XxvEthernetUtilEnterLocalLoopback </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_xxv_ethernet.html">XXxvEthernet</a> *&#160;</td>
          <td class="paramname"><em>XxvEthernetInstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets 10G ethernet in local loopback. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">XxvEthernetInstancePtr</td><td>is a pointer to the instance of the XxvEthernet component.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS if successful.<ul>
<li>XST_FAILURE, in case of failure..</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_xxv_ethernet___config.html#a7224e895cfa19a244b6394008f72b892">XXxvEthernet_Config::BaseAddress</a>, <a class="el" href="struct_x_xxv_ethernet.html#a59619b2a855f14b1fb7970acdce87206">XXxvEthernet::Config</a>, <a class="el" href="group__xxvethernet.html#ga739e90cc435465f16f1c78705a69e7e5">XXxvEthernet_ReadReg</a>, and <a class="el" href="group__xxvethernet.html#gaf8fe72cb95db1fbc60514b6485020108">XXxvEthernet_WriteReg</a>.</p>

<p>Referenced by <a class="el" href="xxxvethernet__example__intr__mcdma_8c.html#a2ab44798c93b77a1cf837f04bc809db7">XxvEthernetSgDmaIntrExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ae5577a2e1499d8be6c88fcac63e8d553"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XxvEthernetUtilErrorTrap </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>Message</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function is called by example code when an error is detected. </p>
<p>It can be set as a breakpoint with a debugger or it can be used to print out the given message if there is a UART or STDIO device.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">Message</td><td>is the text explaining the error</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None </dd></dl>

<p>Referenced by <a class="el" href="xxxvethernet__example__intr__mcdma_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>, <a class="el" href="xxxvethernet__example__intr__mcdma_8c.html#a2ab44798c93b77a1cf837f04bc809db7">XxvEthernetSgDmaIntrExample()</a>, and <a class="el" href="xxxvethernet__example__intr__mcdma_8c.html#a8b7170116154c4ce8b89da78bdf9070d">XxvEthernetSgDmaIntrSingleFrameExample()</a>.</p>

</div>
</div>
<a class="anchor" id="a445292fcf7f28cbf3a9c379eb311b371"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XxvEthernetUtilFrameHdrFormatMAC </td>
          <td>(</td>
          <td class="paramtype">EthernetFrame *&#160;</td>
          <td class="paramname"><em>FramePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>DestAddr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char *&#160;</td>
          <td class="paramname"><em>SrcAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the MAC addresses in the frame. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">FramePtr</td><td>is the pointer to the frame. </td></tr>
    <tr><td class="paramname">DestAddr</td><td>is the Destination MAC address.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="xxxvethernet__example__intr__mcdma_8c.html#a8b7170116154c4ce8b89da78bdf9070d">XxvEthernetSgDmaIntrSingleFrameExample()</a>.</p>

</div>
</div>
<a class="anchor" id="a10525c2457e7790f874b9bef3635b322"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XxvEthernetUtilFrameHdrFormatType </td>
          <td>(</td>
          <td class="paramtype">EthernetFrame *&#160;</td>
          <td class="paramname"><em>FramePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>FrameType</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Set the frame type for the specified frame. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">FramePtr</td><td>is the pointer to the frame. </td></tr>
    <tr><td class="paramname">FrameType</td><td>is the Type to set in frame.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="xxxvethernet__example__intr__mcdma_8c.html#a8b7170116154c4ce8b89da78bdf9070d">XxvEthernetSgDmaIntrSingleFrameExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ad9494c30f93da4a8476ec61c8b1605b5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XxvEthernetUtilFrameMemClear </td>
          <td>(</td>
          <td class="paramtype">EthernetFrame *&#160;</td>
          <td class="paramname"><em>FramePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets all bytes of a frame to 0. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">FramePtr</td><td>is a pointer to the frame itself.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="xxxvethernet__example__intr__mcdma_8c.html#a8b7170116154c4ce8b89da78bdf9070d">XxvEthernetSgDmaIntrSingleFrameExample()</a>.</p>

</div>
</div>
<a class="anchor" id="a3435bac2a9a1be6bd28fda22f93c5f7c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XxvEthernetUtilFrameSetPayloadData </td>
          <td>(</td>
          <td class="paramtype">EthernetFrame *&#160;</td>
          <td class="paramname"><em>FramePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>PayloadSize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function places a pattern in the payload section of a frame. </p>
<p>The pattern is a 8 bit incrementing series of numbers starting with 0. Once the pattern reaches 256, then the pattern changes to a 16 bit incrementing pattern: </p>
<pre>
  0, 1, 2, ... 254, 255, 00, 00, 00, 01, 00, 02, ...
</pre><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">FramePtr</td><td>is a pointer to the frame to change. </td></tr>
    <tr><td class="paramname">PayloadSize</td><td>is the number of bytes in the payload that will be set.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="xxxvethernet__example__intr__mcdma_8c.html#a8b7170116154c4ce8b89da78bdf9070d">XxvEthernetSgDmaIntrSingleFrameExample()</a>.</p>

</div>
</div>
<a class="anchor" id="a9442be912857bc50928bb7a53d5b6685"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XxvEthernetUtilFrameVerify </td>
          <td>(</td>
          <td class="paramtype">EthernetFrame *&#160;</td>
          <td class="paramname"><em>CheckFrame</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">EthernetFrame *&#160;</td>
          <td class="paramname"><em>ActualFrame</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function verifies the frame data against a CheckFrame. </p>
<p>Validation occurs by comparing the ActualFrame to the header of the CheckFrame. If the headers match, then the payload of ActualFrame is verified for the same pattern Util_FrameSetPayloadData() generates.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">CheckFrame</td><td>is a pointer to a frame containing the 14 byte header that should be present in the ActualFrame parameter. </td></tr>
    <tr><td class="paramname">ActualFrame</td><td>is a pointer to a frame to validate.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if successful.</li>
<li>XST_FAILURE in case of failure.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="xxxvethernet__example__intr__mcdma_8c.html#a8b7170116154c4ce8b89da78bdf9070d">XxvEthernetSgDmaIntrSingleFrameExample()</a>.</p>

</div>
</div>
<a class="anchor" id="ad48448f068a15369349deec579b8fc38"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XxvEthernetUtilUsxgmiiSetup </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_xxv_ethernet.html">XXxvEthernet</a> *&#160;</td>
          <td class="paramname"><em>XxvEthernetInstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Rate</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Duplex</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets up USXGMII at specified speed. </p>
<p>Autonegotiation is enabled with the selected settings. If autonegotiation fails, it is restarted after a timeout. The function returns success after autonegotiation is completed. This function enables RX and performs a GT reset first because USXGMII requires the same.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">XxvEthernetInstancePtr</td><td>is a pointer to the instance of the XxvEthernet component. </td></tr>
    <tr><td class="paramname">Speed</td><td>- can be 1G or 2.5G - use RATE_1G or RATE_2G5 </td></tr>
    <tr><td class="paramname">Duplex</td><td>- 1 for full duplex, 0 for half duplex</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS if successful.<ul>
<li>XST_FAILURE, in case of failure..</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_xxv_ethernet___config.html#a7224e895cfa19a244b6394008f72b892">XXxvEthernet_Config::BaseAddress</a>, <a class="el" href="struct_x_xxv_ethernet.html#a59619b2a855f14b1fb7970acdce87206">XXxvEthernet::Config</a>, <a class="el" href="group__xxvethernet.html#ga3da7712d31fdec7ef6b9079103304c47">XXxvEthernet_GetUsxgmiiAnSts</a>, <a class="el" href="group__xxvethernet.html#gabcf02a5b2b0ee38739bbe4fdc5691a59">XXxvEthernet_SetOptions()</a>, <a class="el" href="group__xxvethernet.html#ga387d88a4897e7dc60d5709c60d1e6b89">XXxvEthernet_SetUsxgmiiAnEnable</a>, <a class="el" href="group__xxvethernet.html#ga09e63e61d122a4f18d3dcd51456a1924">XXxvEthernet_SetUsxgmiiRateAndDuplex()</a>, <a class="el" href="group__xxvethernet.html#ga3b0404e1d23019f56969ed3747175b44">XXxvEthernet_UsxgmiiAnMainRestart()</a>, and <a class="el" href="group__xxvethernet.html#gaf8fe72cb95db1fbc60514b6485020108">XXxvEthernet_WriteReg</a>.</p>

</div>
</div>
<a class="anchor" id="a80999962d45ad1ec4e8dcb68df838cdf"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XxvEthernetUtilUsxgmiiSetupBypassAN </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_xxv_ethernet.html">XXxvEthernet</a> *&#160;</td>
          <td class="paramname"><em>XxvEthernetInstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Rate</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>Duplex</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets up USXGMII at specified speed. </p>
<p>Autonegotiation is bypassed and the status is checked for completion before returning successfully. This function enables RX and performs a GT reset first because USXGMII requires the same.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">XxvEthernetInstancePtr</td><td>is a pointer to the instance of the XxvEthernet component. </td></tr>
    <tr><td class="paramname">Speed</td><td>- can be 1G or 2.5G - use RATE_1G or RATE_2G5 </td></tr>
    <tr><td class="paramname">Duplex</td><td>- 1 for full duplex, 0 for half duplex</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>- XST_SUCCESS if successful.<ul>
<li>XST_FAILURE, in case of failure..</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_xxv_ethernet___config.html#a7224e895cfa19a244b6394008f72b892">XXxvEthernet_Config::BaseAddress</a>, <a class="el" href="struct_x_xxv_ethernet.html#a59619b2a855f14b1fb7970acdce87206">XXxvEthernet::Config</a>, <a class="el" href="group__xxvethernet.html#ga3da7712d31fdec7ef6b9079103304c47">XXxvEthernet_GetUsxgmiiAnSts</a>, <a class="el" href="group__xxvethernet.html#gabcf02a5b2b0ee38739bbe4fdc5691a59">XXxvEthernet_SetOptions()</a>, <a class="el" href="group__xxvethernet.html#gab0c7d1348f9f31f7abded0d0fa20de64">XXxvEthernet_SetUsxgmiiAnBypass</a>, <a class="el" href="group__xxvethernet.html#ga09e63e61d122a4f18d3dcd51456a1924">XXxvEthernet_SetUsxgmiiRateAndDuplex()</a>, <a class="el" href="group__xxvethernet.html#ga3b0404e1d23019f56969ed3747175b44">XXxvEthernet_UsxgmiiAnMainRestart()</a>, and <a class="el" href="group__xxvethernet.html#gaf8fe72cb95db1fbc60514b6485020108">XXxvEthernet_WriteReg</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
